/digitalIdentity
[POST]
This operation creates digital identity and resending of activation URL.
https://[host]:[port]/shared-domain-ux/v1/{businessId}/digitalIdentity
CWP URL
https://nonprod.cwp.esb.cloud.lla.com/test/shared-domain-ux-cwp/shared-domain-ux/v1/PA/digitalIdentity
LCR URL
https://nonprod.lcr.esb.cloud.lla.com/test/shared-domain-ux-lcr/shared-domain-ux/v1/CR/digitalIdentity
url Param
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| name | value | description | required |
|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Body
| name | type | description | required |
|---|
| contactMedium | array | contains contact information related to the digital identity | Y |
| contactMedium.id | string | Identifier of the line item; default = "1" | Y |
| contactMedium.contactType | string | represents the category of the contact; default = "Personal" | Y |
| contactMedium.preferred | boolean | represents the default behavior of the contact medium; default = True | Y |
| contactMedium.emailAddress | string | contains the email address for the creation of Digital Identity ex: user@email.com | Y |
| contactMedium.'@type' | string | represents the type of the contact medium; default = "EmailMedium" | Y |
| contactMedium.id | string | Identifier of the line item; default = "2" | N |
| contactMedium.contactType | string | represents the category of the contact; default = "Personal" | N |
| contactMedium.preferred | boolean | represents the default behavior of the contact medium; default = True | N |
| contactMedium.phoneNumber | string | contains the phone number of the customer ex: 50688887777 | N |
| contactMedium.'@type' | string | represents the type of the contact medium; default = "PhoneMedium" | N |
| credential | array | contains credential information for creating digital identity | Y |
| credential.id | string | Identifier of the line item; default = "1" | Y |
| credential.login | string | contains login email information; ex: user@email.com | Y |
| credential.'@type' | string | contains the type of credentials; default = "LoginPasswordCredential" | Y |
| individualIdentified.id | string | Customer ID | Y |
| individualIdentified.individualIdentification | array | Contains identification documents and verification details of the individual. | Y |
| individualIdentified.individualIdentification.identificationId | string | The value of the identification document (ID Proof) | Y |
| individualIdentified.individualIdentification.identificationType | string | Type of identification document; ex: Cedula, Pasaporte | Y |
| individualIdentified.individualIdentification.issuingAuthority | string | Issuing authority of the identification document; ex: PA | Y |
| individualIdentified.individualIdentification.identificationId | string | Billing Account Number | Y for PA; N for LCR |
| individualIdentified.individualIdentification.identificationType | string | Type of identification document; default = "BillingAccount" | Y for PA; N for LCR |
| individualIdentified.name | string | First Name of the customer ++ ; ++ Last Name of the customer | Y |
| individualIdentified.role | string | Role of the individual in the context of the digital identity; default = "Customer" | Y |
| individualIdentified.'@type' | string | Specifies the entity type for the individual object; default = "Individual" | Y |
| '@type' | string | Default = "DigitalIdentity" | Y |
| characteristic | string | extended tmf model for including order characteristics | N |
| characteristic.name | string | contains the type of the order id; default = "triggeringOrderId" | N |
| characteristic.value | string | Order Id | N |
| characteristic.'@type' | string | Default = "Characteristic" | N |
cURL request
curl --location 'https://nonprod.{bgid}.esb.cloud.lla.com/test/shared-domain-ux-{bgid}/shared-domain-ux/v1/{businessId}/digitalIdentity' \
--header 'client_id: xxxxxxxxx' \
--header 'client_secret: xxxxxxxxxxx' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"contactMedium": [
{
"id": "1",
"contactType": "Personal",
"preferred": true,
"emailAddress": "user@email.com",
"@type": "EmailMedium"
},
{
"id": "2",
"contactType": "Personal",
"preferred": true,
"phoneNumber": "50688887777",
"@type": "PhoneMedium"
}
],
"credential": [
{
"id": "1",
"login": "suepitti15@email.com",
"@type": "LoginPasswordCredential"
}
],
"individualIdentified": {
"@type": "Individual",
"id": "35428556",
"individualIdentification":
[
{
"identificationId": "4-187-663",
"identificationType": "CEDULA",
"issuingAuthority": "PA"
},
{
"identificationId": "354285560000",
"identificationType": "BillingAccount"
}
],
"name": "LuisCaballero;Castillo",
"role": "Customer"
},
"characteristic": [
{
"name": "triggeringOrderId",
"value": "55558888",
"@type": "Characteristic"
}
],
"@type": "DigitalIdentity"
}'
Response
{
"id": "digid-123456",
"status": "Pending",
"contactMedium": [
{
"id": "1",
"contactType": "Personal",
"preferred": true,
"emailAddress": "user@email.com",
"@type": "EmailMedium"
},
{
"id": "2",
"contactType": "Personal",
"preferred": true,
"phoneNumber": "50688887777",
"@type": "PhoneMedium"
}
],
"credential": [
{
"id": "1",
"login": "user@email.com",
"@type": "LoginPasswordCredential"
}
],
"individualIdentified": {
"@type": "Individual",
"id": "35428556",
"individualIdentification":
[
{
"identificationId": "4-187-663",
"identificationType": "CEDULA",
"issuingAuthority": "PA"
},
{
"identificationId": "354285560000",
"identificationType": "BillingAccount"
}
],
"name": "Luis Caballero; Castillo",
"role": "Customer"
},
"characteristic": [
{
"name": "triggeringOrderId",
"value": "55558888",
"@type": "Characteristic"
}
],
"@type": "DigitalIdentity"
}